RelinquishFocus

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODArbitrator

RelinquishFocus
The RelinquishFocus method is called by the current owner of the specified focus to relinquish ownership of it.
void RelinquishFocus (in ODTypeToken focus, 
                      in ODFrame relinquishingFrame);
focus
A tokenized string representing the focus type to be relinquished, expressed as a 32-bit value.
relinquishingFrame
A reference to a frame relinquishing ownership of the focus.

DISCUSSION
The focus parameter must be the tokenized form of one of the focus constants (kODClipboardFocus, kODKeyFocus, kODMenuFocus, kODModalFocus, kODMouseFocus, kODScrollingFocus, or kODSelectionFocus) or the tokenized form of a part-specific focus type. You can call the session object's Tokenize method to obtain a token corresponding to one of these constants.
If the focus is exclusive, it has no owner after this method executes successfully.

EXCEPTIONS

kODErrFocusNotRegistered
The specified focus is not registered.

SEE ALSO
The ODFocusType type (page 889).
The ODTypeToken type (page 877).
The ODArbitrator::RelinquishFocusSet method (page 53).
The ODSession::Tokenize method (page 622).
Listing 2-31 on page 88 in OpenDoc Cookbook.
"Relinquishing Foci" on page 208 in OpenDoc Programmer's Guide.
"Acquiring and Relinquishing the Clipboard Focus" on page 356 in OpenDoc Programmer's Guide.